/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2017 by Hitachi Vantara : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

package org.pentaho.metaverse.api;

import java.util.Set;

/**
 * Provides IDocumentLocators to the Metaverse
 */
public interface IDocumentLocatorProvider {

  /**
   * Returns all known DocumentLocators available in the metaverse
   * @return a Set of IDocumentLocators
   */
  Set<IDocumentLocator> getDocumentLocators();

  /**
   * Adds a locator
   * @param documentLocator IDocumentLocator to add
   */
  void addDocumentLocator( IDocumentLocator documentLocator );

  /**
   * Removes a locator
   * @param documentLocator IDocumentLocator to remove
   * @return success or failure (true or false)
   */
  boolean removeDocumentLocator( IDocumentLocator documentLocator );

}
